Skip to content

Use crddoc tool to generate CRD documentation #5565

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Apr 14, 2025
Merged

Use crddoc tool to generate CRD documentation #5565

merged 1 commit into from
Apr 14, 2025
+9 −9

Conversation

@mboersma
Copy link
Contributor

@mboersma mboersma commented Apr 14, 2025 •
edited
Loading

What type of PR is this?

/kind failing-test

What this PR does / why we need it:

Fixes a doc generation error by switching from an unmaintained community tool to a more active fork developed by our friends at ASO.

Which issue(s) this PR fixes:

Fixes #5564

Special notes for your reviewer:

TODOs:

  • squashed commits
  • includes documentation
  • adds unit tests
  • cherry-pick candidate

Release note:

NONE

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/failing-test Categorizes issue or PR as related to a consistently or frequently failing test. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Apr 14, 2025
@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Apr 14, 2025
@codecov
Copy link

codecov bot commented Apr 14, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 52.86%. Comparing base (5ec5ca9) to head (251e114).
Report is 2 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #5565   +/-   ##
=======================================
  Coverage   52.86%   52.86%           
=======================================
  Files         272      272           
  Lines       29474    29474           
=======================================
  Hits        15582    15582           
  Misses      13080    13080           
  Partials      812      812

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Apr 14, 2025
@mboersma
Copy link
Contributor Author

mboersma commented Apr 14, 2025

I checked to see what ASO is doing, and they're using a maintained fork of the gen-crd-documentation tool. I think that's the way to go, so I'm trying to get it working.

@mboersma mboersma force-pushed the fix-crd-docs-generation branch from 36afc81 to 251e114 Compare April 14, 2025 18:42
@mboersma
Copy link
Contributor Author

mboersma commented Apr 14, 2025

/retitle Use crddoc tool to generate CRD documentation

@k8s-ci-robot k8s-ci-robot changed the title Update mdbook and crd docs generator Use crddoc tool to generate CRD documentation Apr 14, 2025
@mboersma mboersma mentioned this pull request Apr 14, 2025
Merged
4 tasks
@mboersma mboersma requested review from Jont828, nawazkh and willie-yao and removed request for jackfrancis and marosset April 14, 2025 18:55
@mboersma mboersma moved this from Todo to Needs Review in CAPZ Planning Apr 14, 2025
@mboersma mboersma added this to the v1.20 milestone Apr 14, 2025
willie-yao
willie-yao approved these changes Apr 14, 2025
View reviewed changes
Copy link
Contributor

@willie-yao willie-yao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 14, 2025
@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Apr 14, 2025

LGTM label has been added.

Git tree hash: 4b0c8a37f2d790c737ee3b8a1f0e95ec73ea6499

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 14, 2025
@nawazkh
Copy link
Member

nawazkh commented Apr 14, 2025

/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Apr 14, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: nawazkh, willie-yao

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot merged commit d5b47bf into kubernetes-sigs:main Apr 14, 2025
21 of 22 checks passed
@github-project-automation github-project-automation bot moved this from Needs Review to Done in CAPZ Planning Apr 14, 2025
@mboersma mboersma deleted the fix-crd-docs-generation branch April 14, 2025 19:31
@mboersma mboersma mentioned this pull request Apr 16, 2025
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@willie-yao willie-yao willie-yao approved these changes

@Jont828 Jont828 Awaiting requested review from Jont828

@nawazkh nawazkh Awaiting requested review from nawazkh

Assignees

@nawazkh nawazkh

@willie-yao willie-yao

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/failing-test Categorizes issue or PR as related to a consistently or frequently failing test. lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesn't merit a release note. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

CAPZ Planning
Status: Done

Milestone

v1.20

Development

Successfully merging this pull request may close these issues.

CRD docs generation failing

4 participants

@mboersma @k8s-ci-robot @nawazkh @willie-yao